SonarSource Rules
  • Products

    In-IDE

    Code Quality and Security in your IDE with SonarQube Ide

    IDE extension that lets you fix coding issues before they exist!

    Discover SonarQube for IDE

    SaaS

    Code Quality and Security in the cloud with SonarQube Cloud

    Setup is effortless and analysis is automatic for most languages

    Discover SonarQube Cloud

    Self-Hosted

    Code Quality and Security Self-Hosted with SonarQube Server

    Fast, accurate analysis; enterprise scalability

    Discover SonarQube Server
  • SecretsSecrets
  • ABAPABAP
  • AnsibleAnsible
  • ApexApex
  • AzureResourceManagerAzureResourceManager
  • CC
  • C#C#
  • C++C++
  • CloudFormationCloudFormation
  • COBOLCOBOL
  • CSSCSS
  • DartDart
  • DockerDocker
  • FlexFlex
  • GitHub ActionsGitHub Actions
  • GoGo
  • HTMLHTML
  • JavaJava
  • JavaScriptJavaScript
  • JSONJSON
  • JCLJCL
  • KotlinKotlin
  • KubernetesKubernetes
  • Objective CObjective C
  • PHPPHP
  • PL/IPL/I
  • PL/SQLPL/SQL
  • PythonPython
  • RPGRPG
  • RubyRuby
  • RustRust
  • ScalaScala
  • ShellShell
  • SwiftSwift
  • TerraformTerraform
  • TextText
  • TypeScriptTypeScript
  • T-SQLT-SQL
  • VB.NETVB.NET
  • VB6VB6
  • XMLXML
  • YAMLYAML
Ruby

Ruby static code analysis

Unique rules to find Bugs, Security Hotspots, and Code Smells in your RUBY code

  • All rules 42
  • Bug7
  • Security Hotspot2
  • Code Smell33
 
Tags
    Impact
      Clean code attribute
        1. Multi-line comments should not be empty

           Code Smell
        2. Methods should not have identical implementations

           Code Smell
        3. Cognitive Complexity of functions should not be too high

           Code Smell
        4. Ruby parser failure

           Code Smell
        5. Boolean checks should not be inverted

           Code Smell
        6. Two branches in a conditional structure should not have exactly the same implementation

           Code Smell
        7. "case" statements should not be nested

           Code Smell
        8. Unused local variables should be removed

           Code Smell
        9. "case" statements should not have too many "when" clauses

           Code Smell
        10. Track lack of copyright and license headers

           Code Smell
        11. Functions should not have too many lines of code

           Code Smell
        12. Control flow statements "if", "for", "while", "until", "case" and "begin...rescue" should not be nested too deeply

           Code Smell
        13. Octal values should not be used

           Code Smell
        14. "case" statements should have "else" clauses

           Code Smell
        15. "if ... else if" constructs should end with "else" clauses

           Code Smell
        16. Statements should be on separate lines

           Code Smell
        17. String literals should not be duplicated

           Code Smell
        18. Methods should not be empty

           Code Smell
        19. Unused function parameters should be removed

           Code Smell
        20. Function and block parameter names should comply with a naming convention

           Code Smell
        21. "case when" clauses should not have too many lines of code

           Code Smell
        22. Track uses of "TODO" tags

           Code Smell
        23. Track uses of "FIXME" tags

           Code Smell
        24. Redundant pairs of parentheses should be removed

           Code Smell
        25. Nested blocks of code should not be left empty

           Code Smell
        26. Functions should not have too many parameters

           Code Smell
        27. Expressions should not be too complex

           Code Smell
        28. Mergeable "if" statements should be combined

           Code Smell
        29. Tabulation characters should not be used

           Code Smell
        30. Files should not have too many lines of code

           Code Smell
        31. Lines should not be too long

           Code Smell
        32. Class names should comply with a naming convention

           Code Smell
        33. Method names should comply with a naming convention

           Code Smell

        Functions should not have too many parameters

        adaptability - focused
        maintainability
        Code Smell
        • brain-overload

        Why is this an issue?

        Functions with a long parameter list are difficult to use because maintainers must figure out the role of each parameter and keep track of their position.

        def modify(x1, y1, z1, x2, y2, z2) # Noncompliant
         # ...
        end
        

        The solution can be to:

        • Split the function into smaller ones
        # Each function does a part of what the original distance function was doing, so confusion risks are lower
        def move(x, y, z)
           # ...
        end
        
        def resize(width, height, depth)
           # ...
        end
        
        • Find a better data structure for the parameters that group data in a way that makes sense for the specific application domain
        Point = Struct.new(:x, :y, :z) # In geometry, Point is a logical structure to group data
        
        def modify(p1, p2)
         # ...
        end
        

        This rule raises an issue when a function has more parameters than the provided threshold.

          Available In:
        • SonarQube IdeCatch issues on the fly,
          in your IDE
        • SonarQube CloudDetect issues in your GitHub, Azure DevOps Services, Bitbucket Cloud, GitLab repositories
        • SonarQube Community BuildAnalyze code in your
          on-premise CI
          Available Since
          9.1
        • SonarQube ServerAnalyze code in your
          on-premise CI
          Developer Edition
          Available Since
          9.1

        © 2008-2025 SonarSource SA. All rights reserved.

        Privacy Policy | Cookie Policy | Terms of Use